/*
 * Copyright 2012 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.spockframework.mock.response;

import org.spockframework.mock.*;
import org.spockframework.util.ThreadSafe;

import java.util.function.Supplier;

@ThreadSafe
public abstract class SingleResponseGenerator implements IChainableResponseGenerator {
  private volatile boolean endOfCycle = false;

  @Override
  public final boolean isAtEndOfCycle() {
    return endOfCycle;
  }

  @Override
  public final Supplier<Object> getResponseSupplier(IMockInvocation invocation) {
    endOfCycle = true;
    return () -> doRespond(invocation);
  }

  /**
   * Returns the response to be made for the given invocation.
   *
   * @param invocation The invocation to generate a response for
   * @return The generated response
   */
  protected abstract Object doRespond(IMockInvocation invocation);
}
